home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / MrmFetchColorLiteral.z / MrmFetchColorLiteral
Text File  |  1998-10-30  |  6KB  |  133 lines

  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll - Fetches a named color literal from a
  10.           UID file
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Mrm/MrmPublic.h>
  14.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll(
  15.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,
  16.           SSSSttttrrrriiiinnnngggg iiiinnnnddddeeeexxxx,
  17.           DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,
  18.           CCCCoooolllloooorrrrmmmmaaaapppp ccccoooolllloooorrrrmmmmaaaapppp____iiiidddd,
  19.           PPPPiiiixxxxeeeellll ****ppppiiiixxxxeeeellll);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           The MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallllfunction fetches a named color
  26.           literal from a UID file, and converts the color literal to a
  27.           pixel color value.
  28.  
  29.           _h_i_e_r_a_r_c_h_y__i_d
  30.                     Specifies the ID of the UID hierarchy that
  31.                     contains the specified literal.  The value of
  32.                     _h_i_e_r_a_r_c_h_y__i_d was returned in a previous call to
  33.                     MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  34.  
  35.           _i_n_d_e_x     Specifies the UIL name of the color literal to
  36.                     fetch.  You must define this name in UIL as an
  37.                     exported value.
  38.  
  39.           _d_i_s_p_l_a_y   Specifies the display used for the pixmap.  The
  40.                     _d_i_s_p_l_a_yargument specifies the connection to the X
  41.                     server.  For more information on the DDDDiiiissssppppllllaaaayyyy
  42.                     structure, see the Xlib function XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy.
  43.  
  44.           _c_o_l_o_r_m_a_p__i_d
  45.                     Specifies the ID of the color map.  If _c_o_l_o_r_m_a_p__i_d
  46.                     is NULL, the default color map is used.
  47.  
  48.           _p_i_x_e_l     Returns the ID of the color literal.
  49.  
  50.      RRRREEEETTTTUUUURRRRNNNN
  51.           This function returns one of the following status return
  52.           constants:
  53.  
  54.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  55.                     The function executed successfully.
  56.  
  57.           MMMMrrrrmmmmBBBBAAAADDDD____HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY
  58.                     The hierarchy ID was invalid.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD
  75.                     The color literal was not found in the UIL file.
  76.  
  77.           MMMMrrrrmmmmWWWWRRRROOOONNNNGGGG____TTTTYYYYPPPPEEEE
  78.                     The caller tried to fetch a literal of a type not
  79.                     supported by this function.
  80.  
  81.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  82.                     The function failed.
  83.  
  84.      RRRREEEELLLLAAAATTTTEEEEDDDD
  85.           MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll(3), MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy(3),
  86.           MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll(3), MMMMrrrrmmmmFFFFeeeettttcccchhhhLLLLiiiitttteeeerrrraaaallll(3), and
  87.           XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy(3).
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.